Feat/762 update docs soften warning - #817
Open
lisazeyen wants to merge 7 commits into
Open
Conversation
tgilon
requested changes
Jul 31, 2026
tgilon
left a comment
tgilon
left a comment
Member
There was a problem hiding this comment.
Thank you @lisazeyen for the documentation effort! I would like to align the warnings slightly more precisely. Could you ensure that they are exactly the same? There are 4 identical warnings: two in the README and two in the index.md. Additionally, I found two other mentions of "Open TYNDP" in the release notes. Perhaps you could fix these too.
| # Development status | ||
|
|
||
| **Warning**: Open-TYNDP is under active development and is not yet feature-complete. The current [development status](https://open-tyndp.readthedocs.io/en/latest/#development-status) and general [Limitations](https://open-tyndp.readthedocs.io/en/latest/limitations.html) are important to understand before using the model. The model includes partial data from the TYNDP 2024 cycle, and its validation is ongoing. The github repository [issues](https://github.com/open-energy-transition/open-tyndp/issues) collect known topics we are working on (please feel free to help or make suggestions). The fact that this project relies on a soft-fork strategy implies that [upstream issues](https://github.com/PyPSA/PyPSA-Eur/issues) need to be addressed in the PyPSA-Eur repository. The [documentation](https://open-tyndp.readthedocs.io/) also remains work in progress. | ||
| **Warning**: Open-TYNDP is under active development and is not yet feature-complete. The current [development status](https://open-tyndp.readthedocs.io/en/latest/#development-status) and general [Limitations](https://open-tyndp.readthedocs.io/en/latest/limitations.html) are important to understand before using the model. Benchmarking against the TYNDP 2024 cycle is complete, and development is now moving forward to align with the TYNDP 2026 cycle. The GitHub repository's [issues](https://github.com/open-energy-transition/open-tyndp/issues) collect known topics we are working on (please feel free to help or make suggestions). The fact that this project relies on a soft-fork strategy implies that [upstream issues](https://github.com/PyPSA/PyPSA-Eur/issues) need to be addressed in the PyPSA-Eur repository. The [documentation](https://open-tyndp.readthedocs.io/) also remains work in progress. |
Member
There was a problem hiding this comment.
Could you make sure that the warnings in the README say exactly the same thing? Currently, one of the two links to the website and the other one introduces TYNDP 2026. The wording is slightly different too.
|
|
||
| !!! warning | ||
| Open-TYNDP is under active development and is not yet feature-complete. As of v0.7, Open TYNDP was successfully benchmarked against TYNDP 2024 (see [results](https://open-tyndp.openenergytransition.org)). The current [development status](#development-status) and the general [Limitations](limitations.md) are important to understand before using the model. | ||
| Open-TYNDP is under active development and is not yet feature-complete. As of v0.7, Open-TYNDP was successfully benchmarked against TYNDP 2024 (see [results](https://open-tyndp.openenergytransition.org)). The current [development status](#development-status) and the general [Limitations](limitations.md) are important to understand before using the model. |
Member
There was a problem hiding this comment.
Same here, could you please ensure that the warning is exactly the same in both locations and in the README?
| and the general [Limitations](limitations.md) | ||
| are important to understand before using the model. The following outputs are presented | ||
| for illustrative purposes and do not reflect the quality of the results. | ||
| Open-TYNDP is under active development and is not yet feature-complete. As of v0.7, Open-TYNDP was successfully benchmarked against TYNDP 2024 (see [results](https://open-tyndp.openenergytransition.org)). The current [development status](index.md#development-status) and the general [Limitations](limitations.md) are important to understand before using the model. |
Member
There was a problem hiding this comment.
Suggested change
| Open-TYNDP is under active development and is not yet feature-complete. As of v0.7, Open-TYNDP was successfully benchmarked against TYNDP 2024 (see [results](https://open-tyndp.openenergytransition.org)). The current [development status](index.md#development-status) and the general [Limitations](limitations.md) are important to understand before using the model. | |
| Open-TYNDP is under active development and is not yet feature-complete. As of v0.7, Open-TYNDP was successfully benchmarked against TYNDP 2024 (see [outcomes](https://open-tyndp.openenergytransition.org)). The current [development status](index.md#development-status) and the general [Limitations](limitations.md) are important to understand before using the model. |
| ??? question "When will Open-TYNDP be ready?" | ||
|
|
||
| The project is currently back-casting the 2024 TYNDP cycle to build confidence before aligning with the 2026 TYNDP cycle in Q2 2026. The [development status](index.md#development-status) page provides a detailed roadmap of implemented and planned features. | ||
| Benchmarking of the 2024 NT (National Trends) scenario is complete, giving us confidence in the model's outcomes. We are now moving forward with development to align with the 2026 TYNDP cycle. The [development status](index.md#development-status) page provides a detailed roadmap of implemented and planned features.s |
Member
There was a problem hiding this comment.
Suggested change
| Benchmarking of the 2024 NT (National Trends) scenario is complete, giving us confidence in the model's outcomes. We are now moving forward with development to align with the 2026 TYNDP cycle. The [development status](index.md#development-status) page provides a detailed roadmap of implemented and planned features.s | |
| Benchmarking of the 2024 NT (National Trends) scenario is complete, giving us confidence in the model's outcomes. We are now moving forward with development to align with the 2026 TYNDP cycle. The [development status](index.md#development-status) page provides a detailed roadmap of implemented and planned features. |
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes # (if applicable).
#762
Changes proposed in this Pull Request
Open TYNDP->Open-TYNDPTasks
Workflow
Open issues
Notes
Checklist
Required:
doc/release_notes.md.